Autogenerated HTML docs for v1.8.1.2-545-g2f19ad
diff --git a/git-config.html b/git-config.html index 787c2ce..e253b78 100644 --- a/git-config.html +++ b/git-config.html
@@ -1269,13 +1269,13 @@ <div class="sect1"> <h2 id="_configuration_file">CONFIGURATION FILE</h2> <div class="sectionbody"> -<div class="paragraph"><p>The git configuration file contains a number of variables that affect -the git command’s behavior. The <code>.git/config</code> file in each repository +<div class="paragraph"><p>The Git configuration file contains a number of variables that affect +the Git commands' behavior. The <code>.git/config</code> file in each repository is used to store the configuration for that repository, and <code>$HOME/.gitconfig</code> is used to store a per-user configuration as fallback values for the <code>.git/config</code> file. The file <code>/etc/gitconfig</code> can be used to store a system-wide default configuration.</p></div> -<div class="paragraph"><p>The configuration variables are used by both the git plumbing +<div class="paragraph"><p>The configuration variables are used by both the Git plumbing and the porcelains. The variables are divided into sections, wherein the fully qualified variable name of the variable itself is the last dot-separated segment and the section name is everything before the last @@ -1578,9 +1578,9 @@ <dd> <p> If true, this option enables various workarounds to enable - git to work better on filesystems that are not case sensitive, + Git to work better on filesystems that are not case sensitive, like FAT. For example, if a directory listing finds - "makefile" when git expects "Makefile", git will assume + "makefile" when Git expects "Makefile", Git will assume it is really the same file, and continue to remember it as "Makefile". </p> @@ -1593,13 +1593,13 @@ </dt> <dd> <p> - This option is only used by Mac OS implementation of git. - When core.precomposeunicode=true, git reverts the unicode decomposition + This option is only used by Mac OS implementation of Git. + When core.precomposeunicode=true, Git reverts the unicode decomposition of filenames done by Mac OS. This is useful when sharing a repository between Mac OS and Linux or Windows. - (Git for Windows 1.7.10 or higher is needed, or git under cygwin 1.7). - When false, file names are handled fully transparent by git, - which is backward compatible with older versions of git. + (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). + When false, file names are handled fully transparent by Git, + which is backward compatible with older versions of Git. </p> </dd> <dt class="hdlist1"> @@ -1660,20 +1660,20 @@ </dt> <dd> <p> - If true, makes git check if converting <code>CRLF</code> is reversible when + If true, makes Git check if converting <code>CRLF</code> is reversible when end-of-line conversion is active. Git will verify if a command modifies a file in the work tree either directly or indirectly. For example, committing a file followed by checking out the same file should yield the original file in the work tree. If this is not the case for the current setting of - <code>core.autocrlf</code>, git will reject the file. The variable can - be set to "warn", in which case git will only warn about an + <code>core.autocrlf</code>, Git will reject the file. The variable can + be set to "warn", in which case Git will only warn about an irreversible conversion but continue the operation. </p> <div class="paragraph"><p>CRLF conversion bears a slight chance of corrupting data. -When it is enabled, git will convert CRLF to LF during commit and LF to +When it is enabled, Git will convert CRLF to LF during commit and LF to CRLF during checkout. A file that contains a mixture of LF and -CRLF before the commit cannot be recreated by git. For text +CRLF before the commit cannot be recreated by Git. For text files this is the right thing to do: it corrects line endings such that we have only LF line endings in the repository. But for binary files that are accidentally classified as text the @@ -1682,7 +1682,7 @@ setting the conversion type explicitly in .gitattributes. Right after committing you still have the original file in your work tree and this file is not yet corrupted. You can explicitly tell -git that this file is binary and git will handle the file +Git that this file is binary and Git will handle the file appropriately.</p></div> <div class="paragraph"><p>Unfortunately, the desired effect of cleaning up text files with mixed line endings and the undesired effect of corrupting binary @@ -1738,7 +1738,7 @@ <p> A "proxy command" to execute (as <em>command host port</em>) instead of establishing direct connection to the remote server when - using the git protocol for fetching. If the variable value is + using the Git protocol for fetching. If the variable value is in the "COMMAND for DOMAIN" format, the command is applied only on hostnames ending with the specified domain string. This variable may be set multiple times and is matched in the given order; @@ -1814,7 +1814,7 @@ file in a ".git" subdirectory of a directory and its value differs from the latter directory (e.g. "/path/to/.git/config" has core.worktree set to "/different/path"), which is most likely a -misconfiguration. Running git commands in the "/path/to" directory will +misconfiguration. Running Git commands in the "/path/to" directory will still use "/different/path" as the root of the work tree and can cause confusion unless you know what you are doing (e.g. you are creating a read-only snapshot of the same index to a location different from the @@ -1858,7 +1858,7 @@ several users in a group (making sure all the files and objects are group-writable). When <em>all</em> (or <em>world</em> or <em>everybody</em>), the repository will be readable by all users, additionally to being - group-shareable. When <em>umask</em> (or <em>false</em>), git will use permissions + group-shareable. When <em>umask</em> (or <em>false</em>), Git will use permissions reported by umask(2). When <em>0xxx</em>, where <em>0xxx</em> is an octal number, files in the repository will have this mode value. <em>0xxx</em> will override user’s umask value (whereas the other options will only override @@ -1874,7 +1874,7 @@ </dt> <dd> <p> - If true, git will warn you if the ref name you passed it is ambiguous + If true, Git will warn you if the ref name you passed it is ambiguous and might match multiple refs in the .git/refs/ tree. True by default. </p> </dd> @@ -1973,7 +1973,7 @@ <dd> <p> In addition to <em>.gitignore</em> (per-directory) and - <em>.git/info/exclude</em>, git looks into this file for patterns + <em>.git/info/exclude</em>, Git looks into this file for patterns of files which are not meant to be tracked. "<code>~/</code>" is expanded to the value of <code>$HOME</code> and "<code>~user/</code>" to the specified user’s home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. @@ -2001,7 +2001,7 @@ <dd> <p> In addition to <em>.gitattributes</em> (per-directory) and - <em>.git/info/attributes</em>, git looks into this file for attributes + <em>.git/info/attributes</em>, Git looks into this file for attributes (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same way as for <code>core.excludesfile</code>. Its default value is $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not @@ -2046,9 +2046,9 @@ </dt> <dd> <p> - The command that git will use to paginate output. Can + The command that Git will use to paginate output. Can be overridden with the <code>GIT_PAGER</code> environment - variable. Note that git sets the <code>LESS</code> environment + variable. Note that Git sets the <code>LESS</code> environment variable to <code>FRSX</code> if it is unset when it runs the pager. One can change these settings by setting the <code>LESS</code> variable to some other value. Alternately, @@ -2056,11 +2056,11 @@ global basis by setting the <code>core.pager</code> option. Setting <code>core.pager</code> has no effect on the <code>LESS</code> environment variable behaviour above, so if you want - to override git’s default settings this way, you need + to override Git’s default settings this way, you need to be explicit. For example, to disable the S option in a backward compatible manner, set <code>core.pager</code> to <code>less -+S</code>. This will be passed to the shell by - git, which will translate the final command to + Git, which will translate the final command to <code>LESS=FRSX less -+S</code>. </p> </dd> @@ -2125,7 +2125,7 @@ <li> <p> <code>tabwidth=<n></code> tells how many character positions a tab occupies; this - is relevant for <code>indent-with-non-tab</code> and when git fixes <code>tab-in-indent</code> + is relevant for <code>indent-with-non-tab</code> and when Git fixes <code>tab-in-indent</code> errors. The default tab width is 8. Allowed values are 1 to 63. </p> </li> @@ -2152,7 +2152,7 @@ </p> <div class="paragraph"><p>This can speed up operations like <em>git diff</em> and <em>git status</em> especially on filesystems like NFS that have weak caching semantics and thus -relatively high IO latencies. With this set to <em>true</em>, git will do the +relatively high IO latencies. With this set to <em>true</em>, Git will do the index comparison to the filesystem data in parallel, allowing overlapping IO’s.</p></div> </dd> @@ -2212,9 +2212,9 @@ <p> Tells <em>git add</em> to continue adding files when some files cannot be added due to indexing errors. Equivalent to the <em>--ignore-errors</em> - option of <a href="git-add.html">git-add(1)</a>. Older versions of git accept only + option of <a href="git-add.html">git-add(1)</a>. Older versions of Git accept only <code>add.ignore-errors</code>, which does not follow the usual naming - convention for configuration variables. Newer versions of git + convention for configuration variables. Newer versions of Git honor <code>add.ignoreErrors</code> as well. </p> </dd> @@ -2227,7 +2227,7 @@ after defining "alias.last = cat-file commit HEAD", the invocation "git last" is equivalent to "git cat-file commit HEAD". To avoid confusion and troubles with script usage, aliases that - hide existing git commands are ignored. Arguments are split by + hide existing Git commands are ignored. Arguments are split by spaces, the usual shell quoting and escaping is supported. quote pair and a backslash can be used to quote them. </p> @@ -2297,7 +2297,7 @@ <dd> <p> When a new branch is created with <em>git branch</em> or <em>git checkout</em> - that tracks another branch, this variable tells git to set + that tracks another branch, this variable tells Git to set up pull to rebase instead of merge (see "branch.<name>.rebase"). When <code>never</code>, rebase is never automatically set to true. When <code>local</code>, rebase is set to true for tracked branches of @@ -2623,7 +2623,7 @@ one of <code>header</code> (the header text of the status message), <code>added</code> or <code>updated</code> (files which are added but not committed), <code>changed</code> (files which are changed but not added in the index), - <code>untracked</code> (files which are not tracked by git), + <code>untracked</code> (files which are not tracked by Git), <code>branch</code> (the current branch), or <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting to red). The values of these variables may be specified as in @@ -2642,7 +2642,7 @@ to <code>always</code> if you want all output not intended for machine consumption to use color, to <code>true</code> or <code>auto</code> if you want such output to use color when written to the terminal, or to <code>false</code> or - <code>never</code> if you prefer git commands not to use color unless enabled + <code>never</code> if you prefer Git commands not to use color unless enabled explicitly with some other configuration or the <code>--color</code> option. </p> </dd> @@ -3043,7 +3043,7 @@ </dt> <dd> <p> - Tells git to detect renames. If set to any boolean value, it + Tells Git to detect renames. If set to any boolean value, it will enable basic rename detection. If set to "copies" or "copy", it will detect copies, as well. </p> @@ -3212,7 +3212,7 @@ </dt> <dd> <p> - If the number of objects fetched over the git native + If the number of objects fetched over the Git native transfer is below this limit, then the objects will be unpacked into loose object files. However if the number of received objects equals or @@ -3284,7 +3284,7 @@ <dd> <p> The default for format-patch is to output a signature containing - the git version number. Use this variable to change that default. + the Git version number. Use this variable to change that default. Set this variable to the empty string ("") to suppress signature generation. </p> @@ -3496,7 +3496,7 @@ <p> If true, the server will look up the end-of-line conversion attributes for files to determine the <em>-k</em> modes to use. If - the attributes force git to treat a file as text, + the attributes force Git to treat a file as text, the <em>-k</em> mode will be left blank so CVS clients will treat it as text. If they suppress text conversion, the file will be set with <em>-kb</em> mode, which suppresses any newline munging @@ -3526,7 +3526,7 @@ <dd> <p> Database used by git-cvsserver to cache revision information - derived from the git repository. The exact meaning depends on the + derived from the Git repository. The exact meaning depends on the used database driver, for SQLite (which is the default driver) this is a filename. Supports variable substitution (see <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>). @@ -3941,7 +3941,7 @@ <dd> <p> File containing previously stored cookie lines which should be used - in the git http session, if they match the server. The file format + in the Git http session, if they match the server. The file format of the file to read cookies from should be plain HTTP headers or the Netscape/Mozilla cookie file format (see <a href="curl.html">curl(1)</a>). NOTE that the file specified with http.cookiefile is only used as @@ -3983,7 +3983,7 @@ </dt> <dd> <p> - Enable git’s password prompt for the SSL certificate. Otherwise + Enable Git’s password prompt for the SSL certificate. Otherwise OpenSSL will prompt the user, possibly many times, if the certificate or private key is encrypted. Can be overridden by the <em>GIT_SSL_CERT_PASSWORD_PROTECTED</em> environment variable. @@ -4070,7 +4070,7 @@ <dd> <p> The HTTP USER_AGENT string presented to an HTTP server. The default - value represents the version of the client git such as git/1.7.1. + value represents the version of the client Git such as git/1.7.1. This option allows you to override this value to a more common value such as Mozilla/4.0. This may be necessary, for instance, if connecting through a firewall that restricts HTTP connections to a set @@ -4083,7 +4083,7 @@ </dt> <dd> <p> - Character encoding the commit messages are stored in; git itself + Character encoding the commit messages are stored in; Git itself does not care per se, but this information is necessary e.g. when importing commits from emails or in the gitk graphical history browser (and possibly at other places in the future or in other @@ -4318,10 +4318,10 @@ </dt> <dd> <p> - By default, git does not create an extra merge commit when merging + By default, Git does not create an extra merge commit when merging a commit that is a descendant of the current commit. Instead, the tip of the current branch is fast-forwarded. When set to <code>false</code>, - this variable tells git to create an extra merge commit in such + this variable tells Git to create an extra merge commit in such a case (equivalent to giving the <code>--no-ff</code> option from the command line). When set to <code>only</code>, only such fast-forward merges are allowed (equivalent to giving the <code>--ff-only</code> option from the @@ -4354,10 +4354,10 @@ </dt> <dd> <p> - Tell git that canonical representation of files in the + Tell Git that canonical representation of files in the repository has changed over time (e.g. earlier commits record text files with CRLF line endings, but recent ones use LF line - endings). In such a repository, git can convert the data + endings). In such a repository, Git can convert the data recorded in commits to a canonical form before performing a merge to reduce unnecessary conflicts. For more information, see section "Merging branches with differing checkin/checkout @@ -4481,7 +4481,7 @@ </dt> <dd> <p> - When invoking a custom merge tool, git uses a set of temporary + When invoking a custom merge tool, Git uses a set of temporary files to pass to the tool. If the tool returns an error and this variable is set to <code>true</code>, then these temporary files will be preserved, otherwise they will be removed after the tool has @@ -4522,7 +4522,7 @@ <dd> <p> When rewriting commits with <command> (currently <code>amend</code> or - <code>rebase</code>) and this variable is set to <code>true</code>, git + <code>rebase</code>) and this variable is set to <code>true</code>, Git automatically copies your notes from the original to the rewritten commit. Defaults to <code>true</code>, but see "notes.rewriteRef" below. @@ -4643,7 +4643,7 @@ warning. This is meant to reduce packing time on multiprocessor machines. The required amount of memory for the delta search window is however multiplied by the number of threads. - Specifying 0 will cause git to auto-detect the number of CPU’s + Specifying 0 will cause Git to auto-detect the number of CPU’s and set the number of threads accordingly. </p> </dd> @@ -4660,11 +4660,11 @@ and this config option ignored whenever the corresponding pack is larger than 2 GB. </p> -<div class="paragraph"><p>If you have an old git that does not understand the version 2 <code>*.idx</code> file, +<div class="paragraph"><p>If you have an old Git that does not understand the version 2 <code>*.idx</code> file, cloning or fetching over a non native protocol (e.g. "http" and "rsync") that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the other side may give you a repository that cannot be accessed with your -older version of git. If the <code>*.pack</code> file is smaller than 2 GB, however, +older version of Git. If the <code>*.pack</code> file is smaller than 2 GB, however, you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate the <code>*.idx</code> file.</p></div> </dd> @@ -4688,7 +4688,7 @@ <dd> <p> If the value is boolean, turns on or off pagination of the - output of a particular git subcommand when writing to a tty. + output of a particular Git subcommand when writing to a tty. Otherwise, turns on pagination for the subcommand using the pager specified by the value of <code>pager.<cmd></code>. If <code>--paginate</code> or <code>--no-pager</code> is specified on the command line, it takes @@ -4747,7 +4747,7 @@ </dt> <dd> <p> - Defines the action git push should take if no refspec is given + Defines the action <code>git push</code> should take if no refspec is given on the command line, no refspec is configured in the remote, and no refspec is implied by any of the options given on the command line. Possible values are: @@ -5018,7 +5018,7 @@ </dt> <dd> <p> - Setting this to a value <vcs> will cause git to interact with + Setting this to a value <vcs> will cause Git to interact with the remote with the git-remote-<vcs> helper. </p> </dd> @@ -5038,9 +5038,9 @@ <p> By default, <a href="git-repack.html">git-repack(1)</a> creates packs that use delta-base offset. If you need to share your repository with - git older than version 1.4.4, either directly or via a dumb + Git older than version 1.4.4, either directly or via a dumb protocol such as http, then you need to set this option to - "false" and repack. Access from old git versions over the + "false" and repack. Access from old Git versions over the native protocol are unaffected by this option. </p> </dd> @@ -5201,7 +5201,7 @@ <p> By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the current directory. Setting this variable to <code>false</code> shows paths - relative to the repository root (this was the default for git + relative to the repository root (this was the default for Git prior to v1.5.4). </p> </dd> @@ -5355,7 +5355,7 @@ large number of repositories, and serves them with multiple access methods, and some users need to use different access methods, this feature allows people to specify any of the - equivalent URLs and have git automatically rewrite the URL to + equivalent URLs and have Git automatically rewrite the URL to the best alternative for the particular user, even for a never-before-seen repository on the site. When more than one insteadOf strings match a given URL, the longest match is used. @@ -5371,11 +5371,11 @@ resulting URL will be pushed to. In cases where some site serves a large number of repositories, and serves them with multiple access methods, some of which do not allow push, this feature - allows people to specify a pull-only URL and have git + allows people to specify a pull-only URL and have Git automatically use an appropriate URL to push, even for a never-before-seen repository on the site. When more than one pushInsteadOf strings match a given URL, the longest match is - used. If a remote has an explicit pushurl, git will ignore this + used. If a remote has an explicit pushurl, Git will ignore this setting for that remote. </p> </dd> 